Favicon

You are here: Home > API Reference > Windows > Windows Devices > Get winDevice by Id

Get winDevice by Id

Get winDevice by Id

GET
/v1/organizations/:organizationId/mdm/windows/enterprise/devices/:winDeviceId
Copy to clipboard

Get winDevice by Id

Get winDevice by Id

Request

Add parameter in header authorization
Example: Authorization: Bearer <token>
organizationId string
required
Entity Id or Slug
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$
winDeviceId string
required
Entity Id, IMEI or Serial Number
Match pattern: ^(([a-fA-F0-9]{24})|(\w{1,}))$

Responses

200 Response application/json
status boolean optional
data object optional
id string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
organization string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
admEnterprise string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
mdmUser object optional
id string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
email string optional
≤ 128 characters
displayName string optional
≤ 128 characters
tags array [string] optional
winId string optional
≤ 128 characters
state string optional
PROVISIONING ACTIVE DELETED DELETE_REQUESTED UNKNOWN
config object optional
configDates object optional
customConfig object optional
summary object optional
name string optional
≤ 256 characters
osVersion string optional
≤ 128 characters
osVersionName string optional
≤ 128 characters
os string optional
≤ 128 characters
serialNumber string optional
≤ 128 characters
imei string optional
≤ 128 characters
battery string optional
≤ 128 characters
expirationTimestamp string optional
Format: date-time
supervised boolean optional
image string optional
≤ 128 characters
compliance object optional
scripts array [object] optional
type string optional
once loop onDemand
id string optional
≤ 128 characters
loopTime integer optional
≥ 0
resetDate string optional
Format: date-time
arguments string optional
argumentsProcessed string optional
name string optional
≤ 256 characters
description string optional
≤ 500 characters
runner string optional
≤ 256 characters
scriptsInfo array [object] optional
lastStatusReportTime string optional
Format: date-time
type string optional
≤ 128 characters
winPolicy object optional
id string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
organizationId string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
winEnterpriseId string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
name string optional
≤ 256 characters
config object optional
applications array [object] optional
winApplicationId string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
configuration object optional
action string optional
≤ 128 characters
forceInstall available
applicationsInfo array [object] optional
scripts array [object] optional
type string optional
once loop onDemand
id string optional
≤ 128 characters
loopTime integer optional
≥ 0
resetDate string optional
Format: date-time
arguments string optional
argumentsProcessed string optional
name string optional
≤ 256 characters
description string optional
≤ 500 characters
runner string optional
≤ 256 characters
scriptsInfo array [object] optional
admxConfigs array [object] optional
winAdmxConfigId string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
admxConfigsInfo array [object] optional
id string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
appName string optional
≤ 256 characters
settingType string optional
≤ 256 characters
fileName string optional
≤ 256 characters
description string optional
≤ 256 characters
agentConfiguration object optional
enabled boolean optional
buildTag string optional
≤ 128 characters
allowLocation boolean optional
allowNetworkStatus boolean optional
allowPackageTime boolean optional
allowPackageTransfer boolean optional
assets array [object] optional
mdmAssetId string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
location string optional
≤ 256 characters
assetName string optional
≤ 256 characters
scope string optional
user system all-users
assetsInfo array [object] optional
version integer optional
≥ 0
updatedAt string optional
Format: date-time
createdAt string optional
Format: date-time
deviceWinPolicy object optional
id string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
organizationId string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
winEnterpriseId string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
name string optional
≤ 256 characters
config object optional
applications array [object] optional
winApplicationId string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
configuration object optional
action string optional
≤ 128 characters
forceInstall available
applicationsInfo array [object] optional
scripts array [object] optional
type string optional
once loop onDemand
id string optional
≤ 128 characters
loopTime integer optional
≥ 0
resetDate string optional
Format: date-time
arguments string optional
argumentsProcessed string optional
name string optional
≤ 256 characters
description string optional
≤ 500 characters
runner string optional
≤ 256 characters
scriptsInfo array [object] optional
admxConfigs array [object] optional
winAdmxConfigId string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
admxConfigsInfo array [object] optional
id string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
appName string optional
≤ 256 characters
settingType string optional
≤ 256 characters
fileName string optional
≤ 256 characters
description string optional
≤ 256 characters
agentConfiguration object optional
enabled boolean optional
buildTag string optional
≤ 128 characters
allowLocation boolean optional
allowNetworkStatus boolean optional
allowPackageTime boolean optional
allowPackageTransfer boolean optional
assets array [object] optional
mdmAssetId string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
location string optional
≤ 256 characters
assetName string optional
≤ 256 characters
scope string optional
user system all-users
assetsInfo array [object] optional
version integer optional
≥ 0
updatedAt string optional
Format: date-time
createdAt string optional
Format: date-time
winPolicyAssignments array [object] optional
winPolicyId string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
winPolicy object optional
id string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
organizationId string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
winEnterpriseId string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
name string optional
≤ 256 characters
config object optional
applications array [object] optional
winApplicationId string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
configuration object optional
action string optional
≤ 128 characters
forceInstall available
applicationsInfo array [object] optional
scripts array [object] optional
type string optional
once loop onDemand
id string optional
≤ 128 characters
loopTime integer optional
≥ 0
resetDate string optional
Format: date-time
arguments string optional
argumentsProcessed string optional
name string optional
≤ 256 characters
description string optional
≤ 500 characters
runner string optional
≤ 256 characters
scriptsInfo array [object] optional
admxConfigs array [object] optional
winAdmxConfigId string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
admxConfigsInfo array [object] optional
id string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
appName string optional
≤ 256 characters
settingType string optional
≤ 256 characters
fileName string optional
≤ 256 characters
description string optional
≤ 256 characters
agentConfiguration object optional
enabled boolean optional
buildTag string optional
≤ 128 characters
allowLocation boolean optional
allowNetworkStatus boolean optional
allowPackageTime boolean optional
allowPackageTransfer boolean optional
assets array [object] optional
mdmAssetId string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
location string optional
≤ 256 characters
assetName string optional
≤ 256 characters
scope string optional
user system all-users
assetsInfo array [object] optional
version integer optional
≥ 0
updatedAt string optional
Format: date-time
createdAt string optional
Format: date-time
priority integer optional
≥ 0
winPolicyAssignmentsEnforced array [object] optional
winPolicyId string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
winPolicy object optional
id string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
organizationId string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
winEnterpriseId string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
name string optional
≤ 256 characters
config object optional
applications array [object] optional
winApplicationId string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
configuration object optional
action string optional
≤ 128 characters
forceInstall available
applicationsInfo array [object] optional
scripts array [object] optional
type string optional
once loop onDemand
id string optional
≤ 128 characters
loopTime integer optional
≥ 0
resetDate string optional
Format: date-time
arguments string optional
argumentsProcessed string optional
name string optional
≤ 256 characters
description string optional
≤ 500 characters
runner string optional
≤ 256 characters
scriptsInfo array [object] optional
admxConfigs array [object] optional
winAdmxConfigId string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
admxConfigsInfo array [object] optional
id string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
appName string optional
≤ 256 characters
settingType string optional
≤ 256 characters
fileName string optional
≤ 256 characters
description string optional
≤ 256 characters
agentConfiguration object optional
enabled boolean optional
buildTag string optional
≤ 128 characters
allowLocation boolean optional
allowNetworkStatus boolean optional
allowPackageTime boolean optional
allowPackageTransfer boolean optional
assets array [object] optional
mdmAssetId string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
location string optional
≤ 256 characters
assetName string optional
≤ 256 characters
scope string optional
user system all-users
assetsInfo array [object] optional
version integer optional
≥ 0
updatedAt string optional
Format: date-time
createdAt string optional
Format: date-time
priority integer optional
≥ 0
automationRule object optional
id string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
name string optional
≤ 256 characters
deviceAudiences array [object] optional
id string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
name string optional
≤ 256 characters
reasons array [string] optional
subType string optional
≤ 128 characters
stateHistory array [object] optional
state string optional
PROVISIONING ACTIVE DELETED DELETE_REQUESTED UNKNOWN
date string optional
Format: date-time
config object optional
lastLocation object optional
agent object optional
origin string optional
agent ip
date string optional
Format: date-time
latitude number optional
Format: float · ≥ -90 · ≤ 90
longitude number optional
Format: float · ≥ -180 · ≤ 180
ip string optional
≤ 128 characters
lastReportDate string optional
Format: date-time
address object optional
address string optional
≤ 500 characters
number string optional
≤ 500 characters
postalCode string optional
≤ 500 characters
city string optional
≤ 500 characters
country string optional
≤ 500 characters
ip object optional
origin string optional
agent ip
date string optional
Format: date-time
latitude number optional
Format: float · ≥ -90 · ≤ 90
longitude number optional
Format: float · ≥ -180 · ≤ 180
ip string optional
≤ 128 characters
lastReportDate string optional
Format: date-time
address object optional
address string optional
≤ 500 characters
number string optional
≤ 500 characters
postalCode string optional
≤ 500 characters
city string optional
≤ 500 characters
country string optional
≤ 500 characters
refreshInfoNeeded array [string] optional
enrolledDate string optional
Format: date-time
updatedAt string optional
Format: date-time
createdAt string optional
Format: date-time
{
    "status": true,
    "data": {
        "id": "string",
        "organization": "string",
        "admEnterprise": "string",
        "mdmUser": {
            "id": "string",
            "email": "string"
        },
        "displayName": "string",
        "tags": [
            "string"
        ],
        "winId": "string",
        "state": "PROVISIONING",
        "config": {},
        "configDates": {},
        "customConfig": {},
        "summary": {
            "name": "string",
            "osVersion": "string",
            "osVersionName": "string",
            "os": "string",
            "serialNumber": "string",
            "imei": "string",
            "battery": "string",
            "expirationTimestamp": "2024-01-01T00: 00:00Z",
            "supervised": true,
            "image": "string",
            "compliance": {}
        },
        "scripts": [
            {
                "type": "once",
                "id": "string",
                "loopTime": 0,
                "resetDate": "2024-01-01T00: 00:00Z",
                "arguments": "string",
                "argumentsProcessed": "string",
                "name": "string",
                "description": "string",
                "runner": "string"
            }
        ],
        "scriptsInfo": [
            {}
        ],
        "lastStatusReportTime": "2024-01-01T00: 00:00Z",
        "type": "string",
        "winPolicy": {
            "id": "string",
            "organizationId": "string",
            "winEnterpriseId": "string",
            "name": "string",
            "config": {},
            "applications": [
                {
                    "winApplicationId": "string",
                    "configuration": {},
                    "action": "forceInstall"
                }
            ],
            "applicationsInfo": [
                {}
            ],
            "scripts": [
                {
                    "type": "once",
                    "id": "string",
                    "loopTime": 0,
                    "resetDate": "2024-01-01T00: 00:00Z",
                    "arguments": "string",
                    "argumentsProcessed": "string",
                    "name": "string",
                    "description": "string",
                    "runner": "string"
                }
            ],
            "scriptsInfo": [
                {}
            ],
            "admxConfigs": [
                {
                    "winAdmxConfigId": "string"
                }
            ],
            "admxConfigsInfo": [
                {
                    "id": "string",
                    "appName": "string",
                    "settingType": "string",
                    "fileName": "string",
                    "description": "string"
                }
            ],
            "agentConfiguration": {
                "enabled": true,
                "buildTag": "string",
                "allowLocation": true,
                "allowNetworkStatus": true,
                "allowPackageTime": true,
                "allowPackageTransfer": true
            },
            "assets": [
                {
                    "mdmAssetId": "string",
                    "location": "string",
                    "assetName": "string",
                    "scope": "user"
                }
            ],
            "assetsInfo": [
                {}
            ],
            "version": 0,
            "updatedAt": "2024-01-01T00: 00:00Z",
            "createdAt": "2024-01-01T00: 00:00Z"
        },
        "deviceWinPolicy": {
            "id": "string",
            "organizationId": "string",
            "winEnterpriseId": "string",
            "name": "string",
            "config": {},
            "applications": [
                {
                    "winApplicationId": "string",
                    "configuration": {},
                    "action": "forceInstall"
                }
            ],
            "applicationsInfo": [
                {}
            ],
            "scripts": [
                {
                    "type": "once",
                    "id": "string",
                    "loopTime": 0,
                    "resetDate": "2024-01-01T00: 00:00Z",
                    "arguments": "string",
                    "argumentsProcessed": "string",
                    "name": "string",
                    "description": "string",
                    "runner": "string"
                }
            ],
            "scriptsInfo": [
                {}
            ],
            "admxConfigs": [
                {
                    "winAdmxConfigId": "string"
                }
            ],
            "admxConfigsInfo": [
                {
                    "id": "string",
                    "appName": "string",
                    "settingType": "string",
                    "fileName": "string",
                    "description": "string"
                }
            ],
            "agentConfiguration": {
                "enabled": true,
                "buildTag": "string",
                "allowLocation": true,
                "allowNetworkStatus": true,
                "allowPackageTime": true,
                "allowPackageTransfer": true
            },
            "assets": [
                {
                    "mdmAssetId": "string",
                    "location": "string",
                    "assetName": "string",
                    "scope": "user"
                }
            ],
            "assetsInfo": [
                {}
            ],
            "version": 0,
            "updatedAt": "2024-01-01T00: 00:00Z",
            "createdAt": "2024-01-01T00: 00:00Z"
        },
        "winPolicyAssignments": [
            {
                "winPolicyId": "string",
                "winPolicy": {
                    "id": "string",
                    "organizationId": "string",
                    "winEnterpriseId": "string",
                    "name": "string",
                    "config": {},
                    "applications": [
                        {
                            "winApplicationId": "string",
                            "configuration": {},
                            "action": "forceInstall"
                        }
                    ],
                    "applicationsInfo": [
                        {}
                    ],
                    "scripts": [
                        {
                            "type": "once",
                            "id": "string",
                            "loopTime": 0,
                            "resetDate": "2024-01-01T00: 00:00Z",
                            "arguments": "string",
                            "argumentsProcessed": "string",
                            "name": "string",
                            "description": "string",
                            "runner": "string"
                        }
                    ],
                    "scriptsInfo": [
                        {}
                    ],
                    "admxConfigs": [
                        {
                            "winAdmxConfigId": "string"
                        }
                    ],
                    "admxConfigsInfo": [
                        {
                            "id": "string",
                            "appName": "string",
                            "settingType": "string",
                            "fileName": "string",
                            "description": "string"
                        }
                    ],
                    "agentConfiguration": {
                        "enabled": true,
                        "buildTag": "string",
                        "allowLocation": true,
                        "allowNetworkStatus": true,
                        "allowPackageTime": true,
                        "allowPackageTransfer": true
                    },
                    "assets": [
                        {
                            "mdmAssetId": "string",
                            "location": "string",
                            "assetName": "string",
                            "scope": "user"
                        }
                    ],
                    "assetsInfo": [
                        {}
                    ],
                    "version": 0,
                    "updatedAt": "2024-01-01T00: 00:00Z",
                    "createdAt": "2024-01-01T00: 00:00Z"
                },
                "priority": 0
            }
        ],
        "winPolicyAssignmentsEnforced": [
            {
                "winPolicyId": "string",
                "winPolicy": {
                    "id": "string",
                    "organizationId": "string",
                    "winEnterpriseId": "string",
                    "name": "string",
                    "config": {},
                    "applications": [
                        {
                            "winApplicationId": "string",
                            "configuration": {},
                            "action": "forceInstall"
                        }
                    ],
                    "applicationsInfo": [
                        {}
                    ],
                    "scripts": [
                        {
                            "type": "once",
                            "id": "string",
                            "loopTime": 0,
                            "resetDate": "2024-01-01T00: 00:00Z",
                            "arguments": "string",
                            "argumentsProcessed": "string",
                            "name": "string",
                            "description": "string",
                            "runner": "string"
                        }
                    ],
                    "scriptsInfo": [
                        {}
                    ],
                    "admxConfigs": [
                        {
                            "winAdmxConfigId": "string"
                        }
                    ],
                    "admxConfigsInfo": [
                        {
                            "id": "string",
                            "appName": "string",
                            "settingType": "string",
                            "fileName": "string",
                            "description": "string"
                        }
                    ],
                    "agentConfiguration": {
                        "enabled": true,
                        "buildTag": "string",
                        "allowLocation": true,
                        "allowNetworkStatus": true,
                        "allowPackageTime": true,
                        "allowPackageTransfer": true
                    },
                    "assets": [
                        {
                            "mdmAssetId": "string",
                            "location": "string",
                            "assetName": "string",
                            "scope": "user"
                        }
                    ],
                    "assetsInfo": [
                        {}
                    ],
                    "version": 0,
                    "updatedAt": "2024-01-01T00: 00:00Z",
                    "createdAt": "2024-01-01T00: 00:00Z"
                },
                "priority": 0,
                "automationRule": {
                    "id": "string",
                    "name": "string",
                    "deviceAudiences": [
                        {
                            "id": "string",
                            "name": "string",
                            "reasons": [
                                "string"
                            ]
                        }
                    ]
                }
            }
        ],
        "subType": "string",
        "stateHistory": [
            {
                "state": "PROVISIONING",
                "date": "2024-01-01T00: 00:00Z",
                "config": {}
            }
        ],
        "lastLocation": {
            "agent": {
                "origin": "agent",
                "date": "2024-01-01T00: 00:00Z",
                "latitude": 0,
                "longitude": 0,
                "ip": "string",
                "lastReportDate": "2024-01-01T00: 00:00Z",
                "address": {
                    "address": "string",
                    "number": "string",
                    "postalCode": "string",
                    "city": "string",
                    "country": "string"
                }
            },
            "ip": {
                "origin": "agent",
                "date": "2024-01-01T00: 00:00Z",
                "latitude": 0,
                "longitude": 0,
                "ip": "string",
                "lastReportDate": "2024-01-01T00: 00:00Z",
                "address": {
                    "address": "string",
                    "number": "string",
                    "postalCode": "string",
                    "city": "string",
                    "country": "string"
                }
            }
        },
        "refreshInfoNeeded": [
            "string"
        ],
        "enrolledDate": "2024-01-01T00: 00:00Z",
        "updatedAt": "2024-01-01T00: 00:00Z",
        "createdAt": "2024-01-01T00: 00:00Z"
    }
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4004
message string optional
Invalid Token
{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
404 Response application/json
status boolean optional
false
error object optional
code number optional
3001
message string optional
Entity not found
{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}